/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: shm_allocator.h
 *
 * Purpose: shared memory allocator API define
 *
 * Developer:
 *   wen.gu , 2023-06-15
 *
 * TODO:
 *
 ***************************************************************************/
#ifndef __UDSSIPC_SHM_ALLOCATOR_H__
#define __UDSSIPC_SHM_ALLOCATOR_H__

#include <string>
#include <memory>


class SharedMemory {
public:
    using shared_memory_fd = int32_t;
    constexpr static shared_memory_fd Invalid_Fd = -1;
public:
    virtual ~SharedMemory() = default;
public:
    virtual bool vaild() { return false; }
    virtual void* addr() { return nullptr; }
    virtual uint32_t size() { return 0; }
    virtual const std::string& path() = 0;
    virtual shared_memory_fd fd() { return Invalid_Fd; /** if haven't, then return -1 */}
};


class ShmAllocator {
public:
    using SharedMemoryPtr = std::shared_ptr<SharedMemory>;
public:
    virtual ~ShmAllocator() = default;

public:
    virtual SharedMemoryPtr alloc(const std::string& path, uint32_t size);
    virtual SharedMemoryPtr attach(const std::string& path);
};


#endif /** !__UDSSIPC_SHM_ALLOCATOR_H__ */
